chore(Drawer): Include OUIAProps for Drawer by mshriver · Pull Request #12580 · patternfly/patternfly-react

mshriver · 2026-07-21T15:58:17Z

Add OUIA attribute support to Drawer for better test automation.

What: Closes #12579

Summary by CodeRabbit

New Features
- Added Open UI Automation attributes to the Drawer component.
- Drawer now supports custom automation IDs and configurable automation safety settings.
- Added Drawer to the Open UI Automation component documentation.
Tests
- Added coverage validating Drawer automation attributes and default behavior.

Add OUIA attribute support to Drawer for better test automation. Co-authored-by: Cursor <cursoragent@cursor.com>

coderabbitai · 2026-07-21T15:58:42Z

Important

Review skipped

Review was skipped due to path filters

⛔ Files ignored due to path filters (2)

packages/react-core/src/components/Compass/__tests__/__snapshots__/Compass.test.tsx.snap is excluded by !**/*.snap
packages/react-core/src/components/Compass/__tests__/__snapshots__/CompassContent.test.tsx.snap is excluded by !**/*.snap

CodeRabbit blocks several paths by default. You can override this behavior by explicitly including those paths in the path filters. For example, including **/dist/** will override the default block on the dist directory, by removing the pattern from both the lists.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 79f18606-c956-4f38-9614-d35ac13093b4

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

🔍 Trigger review

Walkthrough

Drawer now supports OUIA props, renders OUIA data attributes on its root element, tests the behavior, and lists Drawer in the OUIA documentation.

Changes

Drawer OUIA integration

Layer / File(s)	Summary
OUIA props and rendering `packages/react-core/src/components/Drawer/Drawer.tsx`	`DrawerProps` now supports `ouiaId` and `ouiaSafe`; the component generates OUIA props and spreads them onto the root element.
Validation and documentation `packages/react-core/src/components/Drawer/__tests__/Drawer.test.tsx`, `packages/react-core/src/helpers/OUIA/OUIA.md`	Tests verify OUIA component ID, type, and safe attributes, while the OUIA component list includes Drawer.

Estimated code review effort: 2 (Simple) | ~10 minutes

Possibly related PRs

patternfly/patternfly-react#12572: Adds equivalent OUIA prop wiring and attribute tests for Popover.
patternfly/patternfly-react#12576: Adds OUIA support to another react-core component with matching tests.

Suggested reviewers: tlabaj

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly and concisely summarizes the main change: adding OUIAProps support to Drawer.
Linked Issues check	✅ Passed	Drawer now supports OUIA props and tests/docs were updated, matching the issue's automation support goal.
Out of Scope Changes check	✅ Passed	The test and OUIA docs updates are directly related to the Drawer OUIA support change.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands.}

coderabbitai

🧹 Nitpick comments (1)

packages/react-core/src/components/Drawer/Drawer.tsx (1)
71-71: 📐 Maintainability & Code Quality | 🔵 Trivial | 💤 Low value

Consider adding a fallback string for the component type.

Since Drawer.displayName is typed as string | undefined on React.FunctionComponent, passing it directly to useOUIAProps (which expects a strict string) could cause a TypeScript error depending on project strictness settings. It could also result in an unwanted PF6/undefined type if the displayName property gets stripped during minification.

Providing a static fallback string ensures a valid, stable ouiaComponentType is always generated.
♻️ Proposed refactor
-  const ouiaProps = useOUIAProps(Drawer.displayName, ouiaId, ouiaSafe);
+  const ouiaProps = useOUIAProps(Drawer.displayName || 'Drawer', ouiaId, ouiaSafe);
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@packages/react-core/src/components/Drawer/Drawer.tsx` at line 71, Update the
useOUIAProps call in Drawer to pass a stable literal fallback when
Drawer.displayName is undefined, ensuring the component type is always a strict,
non-empty string and never generates PF6/undefined.

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Nitpick comments:
In `@packages/react-core/src/components/Drawer/Drawer.tsx`:
- Line 71: Update the useOUIAProps call in Drawer to pass a stable literal
fallback when Drawer.displayName is undefined, ensuring the component type is
always a strict, non-empty string and never generates PF6/undefined.

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 204f2c03-8c1e-4e34-830a-33b0c6dfd3ea

📥 Commits

Reviewing files that changed from the base of the PR and between 7519afe and d3a8a4a.

⛔ Files ignored due to path filters (1)

packages/react-core/src/components/Drawer/__tests__/__snapshots__/Drawer.test.tsx.snap is excluded by !**/*.snap

📒 Files selected for processing (3)

packages/react-core/src/components/Drawer/Drawer.tsx
packages/react-core/src/components/Drawer/__tests__/Drawer.test.tsx
packages/react-core/src/helpers/OUIA/OUIA.md

rebeccaalpert

Ouia stuff looks good, but tests are failing. Would you mind taking a look?

rebeccaalpert

Thank you so much!

chore(Drawer): Include OUIAProps for Drawer

d3a8a4a

Add OUIA attribute support to Drawer for better test automation. Co-authored-by: Cursor <cursoragent@cursor.com>

coderabbitai Bot reviewed Jul 21, 2026

View reviewed changes

coderabbitai Bot mentioned this pull request Jul 21, 2026

Drawer missing OUIA Support #12579

Open

rebeccaalpert self-requested a review July 22, 2026 17:36

rebeccaalpert requested changes Jul 22, 2026

View reviewed changes

This was referenced Jul 22, 2026

chore(ExpandableSection): Include OUIAProps for ExpandableSection #12570

Merged

chore(Popover): Include OUIAProps for Popover #12572

Open

Update snapshot tests for drawer

79ee6d3

rebeccaalpert approved these changes Jul 23, 2026

View reviewed changes

rebeccaalpert requested a review from thatblindgeye July 23, 2026 13:08

This was referenced Jul 23, 2026

Slider missing OUIA Support #12584

Open

chore(Slider): Include OUIAProps for Slider #12585

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

chore(Drawer): Include OUIAProps for Drawer#12580

chore(Drawer): Include OUIAProps for Drawer#12580
mshriver wants to merge 2 commits into
patternfly:mainfrom
mshriver:drawer-ouia

mshriver commented Jul 21, 2026 •

edited by coderabbitai Bot

Loading

Uh oh!

coderabbitai Bot commented Jul 21, 2026 •

edited

Loading

Review skipped

Uh oh!

coderabbitai Bot left a comment

Uh oh!

rebeccaalpert left a comment

Uh oh!

rebeccaalpert left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

mshriver commented Jul 21, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai Bot commented Jul 21, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review skipped

Walkthrough

Changes

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

rebeccaalpert left a comment

Choose a reason for hiding this comment

Uh oh!

rebeccaalpert left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

mshriver commented Jul 21, 2026 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented Jul 21, 2026 •

edited

Loading